ly.img:engine/ly.img.engine/HistoryUpdate

HistoryUpdate

enum HistoryUpdate : Enum<HistoryUpdate>

Describes the kind of update that triggered an EditorApi.onHistoryUpdatedWithKind event.

The order of the values must stay in sync with ubq::editor::HistoryUpdate on the C++ side.

Entries

The active history's snapshots changed: a new snapshot was added (e.g. after an edit), or undo/redo was applied. The scene state changed as a direct consequence of the history update.

ACTIVATED

A different history buffer was activated via EditorApi.setActiveHistory. The undo/redo stack visible to the user changed, but no new snapshot was created and no undo/redo was applied as part of this event.

Properties

entries

val entries: EnumEntries<HistoryUpdate>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): HistoryUpdate

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<HistoryUpdate>

Returns an array containing the constants of this enum type, in the order they're declared.